Skip to content

Files in doc directory #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 23 commits into from
Aug 8, 2024
Merged

Files in doc directory #157

merged 23 commits into from
Aug 8, 2024

Conversation

cadenmyers13
Copy link
Contributor

No description provided.

@cadenmyers13
Copy link
Contributor Author

@sbillinge Discussed a bit with Andrew on where we should put things and this is what I've got right now.

@sbillinge sbillinge merged commit d65d1ee into diffpy:cookie Aug 8, 2024
2 of 3 checks passed
@sbillinge
Copy link
Contributor

this looks about right. Please make a PR with any changes that allow you to build the docs locally, and on a separate PR a workflow with the doc builds in a GitHub action, and we can work to make that pass too.

@cadenmyers13 cadenmyers13 deleted the doc_files2 branch August 8, 2024 18:23
@cadenmyers13
Copy link
Contributor Author

this looks about right. Please make a PR with any changes that allow you to build the docs locally, and on a separate PR a workflow with the doc builds in a GitHub action, and we can work to make that pass too.

docs.yml is already added, no?

@sbillinge
Copy link
Contributor

this looks about right. Please make a PR with any changes that allow you to build the docs locally, and on a separate PR a workflow with the doc builds in a GitHub action, and we can work to make that pass too.

docs.yml is already added, no?

Ah, ok. Let me know when you are confident the docs are building locally and I can merge and it will test the docs build then

@cadenmyers13
Copy link
Contributor Author

this looks about right. Please make a PR with any changes that allow you to build the docs locally, and on a separate PR a workflow with the doc builds in a GitHub action, and we can work to make that pass too.

docs.yml is already added, no?

Ah, ok. Let me know when you are confident the docs are building locally and I can merge and it will test the docs build then

The htmls build when i run make html in doc. However im getting this error:
Screenshot 2024-08-08 at 4 12 13 PM

@sbillinge
Copy link
Contributor

I merged this so we will need the fixes for this on a new PR. Thanks.

sbillinge added a commit that referenced this pull request Aug 20, 2024
* copy .github directory

* nest inside .github

* update for pdfgui

* test tests (#131)

* pin numpy to 1.x for now

* add environment.yml

* test tests

* trigger

* try again with requirements

* try again with requirements

* now update test reqs

* try and handle xwindow display issue

* try using xfvb action

* refactor xvfb action commands

* source activate?

* different tack, generate error and work on test?

* again

* again

* chatgpt method

* supress running qc of meta.yaml in conda-forge by renaming

* try new pyproject.toml

* again2

* forgot to install diffpy.pdfgui!

* back to setup.py

* copyright fixes (#134)

* Flake8v1 (#137)

* move modules to top

* remove extra #s

* line length and extra #s

* extra #s

* modules to top

* replace lambda function and line length

* add # noqa: E501

* modules to top

* fix lambda func

* Flake8v2 (#138)

* fix not in

* fix lambda functions

* remove #

* remove lambda func

* modules to top

* mod to top

* line length and import and #s

* fix line length and #s

* comment unused var, fix imports and #s

* modules to top and inline comment fix

* def functions within function to pass tests

* move functions outside of class

* Flake8v4 (#140)

* capitalize Trustees

* Exception on errorwrapper

* wx.PyObjectError in except

* ValueError and Exception

* Exception

* remove import

* pre-commit errors in comments (#141)

* wx12 and bonlengthdialog (#142)

* wx12 and bonlengthdialog

* devutils/makedist import order

* news (#143)

* cookiecutter: untracked files (#149)

* untracked files

* [pre-commit.ci] auto fixes from pre-commit hooks

* update LICENSE.rst

* update AUTHORS.rst and remove AUTHORS.txt

* tipping our hat

* Remove BSD 3-Clause, leaving Columbia copyright

* remove README from requirements

* replace requirements

* adding wxpython back

* adding back freezegun

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Simon Billinge <[email protected]>

* Files in doc directory (#157)

* move images to _static

* move files in .../doc/manual into doc/source

* move .gitignore file

* move rest of files to doc/

* move makefile from doc/source to doc/

* remove Makefile from doc/source

* update Makefile in doc

* add rest of cookiecutter files into doc/source

* add make.bat file

* moving .py files into doc/manual

* move files into manual

* moving images into manual

* add TUTORIAL.rst

* convert .txt to .rst in TUTORIAL

* fix formating

* formating

* formating

* reference formating

* move TUTORIAL.rst to manual

* move tutorial.rst from manual to source

* rm extra tutorial.rst

* add tutorial section to index.rst

* index.rst formating

* files (#158)

* Replace Caden's PR (#160)

Minor copyright fixes and news update

* try workflow for testing (#161)

* workflow for testing

* test unittest

* try Xvfb

* try to remove no test ran line

* [pre-commit.ci] auto fixes from pre-commit hooks

* try to remove no test ran line

* try pytest

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* remove unused files (#166)

* update requirements/run.txt (#165)

* update requirements/run.txt, include right package

* use matplotlib-base

* remove dependency tests (#169)

* fix deprecation warning when test (#170)

* fix pkg_resources deprecation warning

* use __name__

* daemon deprecation

* rst file changes (#171)

* Use the original license

* other file changes

* add a bit more in readme

* remove epydoc (#173)

* build doc (#174)

* build doc

* pre commit

* Apply the new workflow (#168)

* Apply the new workflow

* remove prerelease from docs workflow

* rename to main

---------

Co-authored-by: Caden Myers <[email protected]>
Co-authored-by: Caden Myers <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Tieqiong <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants